Skip to content

DOC-6631 Python async intro page#3344

Merged
andy-stark-redis merged 4 commits into
mainfrom
DOC-6631-python-async-intro
May 22, 2026
Merged

DOC-6631 Python async intro page#3344
andy-stark-redis merged 4 commits into
mainfrom
DOC-6631-python-async-intro

Conversation

@andy-stark-redis
Copy link
Copy Markdown
Contributor

@andy-stark-redis andy-stark-redis commented May 19, 2026

Note

Low Risk
Low risk docs-only change that adds new guidance and sample code without affecting runtime behavior. Main risk is documentation accuracy/compatibility with redis-py versions and example correctness.

Overview
Adds a new redis-py Async operations doc page (async.md) describing how to use redis.asyncio, including lifecycle/cleanup guidance, pooling recommendations, concurrent awaits, pipelines/transactions, pubsub, cluster usage, and timeouts.

Introduces a new local_examples/.../async_intro.py example set referenced by the page, with step-based snippets for connect/context-manager usage, shared client pooling, asyncio.gather(), async pipelines with WATCH, pub/sub consumption, async cluster client, and command timeouts.

Reviewed by Cursor Bugbot for commit 4a14dd6. Bugbot is set up for automated code reviews on this repo. Configure here.

@andy-stark-redis andy-stark-redis requested a review from a team May 19, 2026 12:47
@andy-stark-redis andy-stark-redis self-assigned this May 19, 2026
@andy-stark-redis andy-stark-redis added the clients Client library docs label May 19, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 19, 2026

DOC-6631

@github-actions
Copy link
Copy Markdown
Contributor

@jit-ci
Copy link
Copy Markdown

jit-ci Bot commented May 19, 2026

🛡️ Jit Security Scan Results

CRITICAL HIGH MEDIUM

✅ No security findings were detected in this PR


Security scan by Jit

Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 32f6b1c. Configure here.

Comment thread local_examples/client-specific/redis-py/async_intro.py
Copy link
Copy Markdown
Collaborator

@dwdougherty dwdougherty left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a couple of nitpicks re. US vs. UK spelling; otherwise LGTM.

Comment thread content/develop/clients/redis-py/async.md Outdated
Comment thread local_examples/client-specific/redis-py/async_intro.py Outdated
Co-authored-by: David Dougherty <david.dougherty@redis.com>
Comment thread content/develop/clients/redis-py/async.md Outdated
@andy-stark-redis andy-stark-redis changed the title DOC-6331 Python async intro page DOC-6631 Python async intro page May 22, 2026
@andy-stark-redis
Copy link
Copy Markdown
Contributor Author

Thanks @dwdougherty and @petyaslavova !

@andy-stark-redis andy-stark-redis merged commit 0c9835c into main May 22, 2026
65 checks passed
@andy-stark-redis andy-stark-redis deleted the DOC-6631-python-async-intro branch May 22, 2026 09:24
Copy link
Copy Markdown

@petyaslavova petyaslavova left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

EliShteinman added a commit to EliShteinman/docs that referenced this pull request May 23, 2026
DOC-6631: new Python async intro page for redis-py.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

clients Client library docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants